Skip to content

/v1/domains/{domainId}/users/invitations/{id}/complete

Request

Complete a user invitation

Security
httpAuth
Path
domainIdstring, (uuid)required
idstring, (uuid)required
curl -i -X POST \
  'https://docs.ripple.com/_mock/products/custody/devbox/v1/domains/{domainId}/users/invitations/{id}/complete' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

OK

Body
idstring, (uuid)required
codestringrequired
statusstringrequired
Enum:"Pending""DeviceRegistered""Expired""Cancelled""Completed"
validUntilstring, (date-time)required
userobjectrequired
metadataobjectrequired
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "code": "string",
  "status": "Pending",
  "validUntil": "2019-08-24T14:15:22Z",
  "user": {
    "alias": "string",
    "customProperties": { … },
    "description": "string",
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "domainId": "8a0b02c3-fdd8-452e-bc6e-ef07a335ec7e",
    "lock": "Unlocked",
    "roles": [ … ],
    "publicKey": "string"
  },
  "metadata": {
    "createdAt": "2019-08-24T14:15:22Z",
    "lastModifiedAt": "2019-08-24T14:15:22Z",
    "createdBy": { … }
  }
}